<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>shark::ImagePatches Class Reference</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceshark.html">shark</a></li><li class="navelem"><a class="el" href="classshark_1_1_image_patches.html">ImagePatches</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="classshark_1_1_image_patches-members.html">List of all members</a> &#124;
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle"><div class="title">shark::ImagePatches Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Given a set of images, draws a set of image patches of a given size.  
 <a href="classshark_1_1_image_patches.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_data_distribution_8h_source.html">shark/Data/DataDistribution.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for shark::ImagePatches:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classshark_1_1_image_patches__inherit__graph.png" border="0" usemap="#ashark_1_1_image_patches_inherit__map" alt="Inheritance graph"/></div>
<map name="ashark_1_1_image_patches_inherit__map" id="ashark_1_1_image_patches_inherit__map">
<area shape="rect" title="Given a set of images, draws a set of image patches of a given size." alt="" coords="10,94,156,120"/>
<area shape="rect" href="classshark_1_1_data_distribution.html" title=" " alt="" coords="5,5,161,46"/>
<area shape="poly" title=" " alt="" coords="86,62,86,93,80,93,80,62"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aebd3397b0cd45f13561ffc1596e95973" id="r_aebd3397b0cd45f13561ffc1596e95973"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_image_patches.html#aebd3397b0cd45f13561ffc1596e95973">ImagePatches</a> (<a class="el" href="classshark_1_1_data.html">Data</a>&lt; RealVector &gt; images, std::size_t imageWidth, std::size_t imageHeight, std::size_t patchWidth, std::size_t patchHeight)</td></tr>
<tr class="separator:aebd3397b0cd45f13561ffc1596e95973"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01400c960d4da83f22837902c459d35e" id="r_a01400c960d4da83f22837902c459d35e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_image_patches.html#a01400c960d4da83f22837902c459d35e">draw</a> (RealVector &amp;input) const</td></tr>
<tr class="memdesc:a01400c960d4da83f22837902c459d35e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a single pair of input and label.  <br /></td></tr>
<tr class="separator:a01400c960d4da83f22837902c459d35e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classshark_1_1_data_distribution"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classshark_1_1_data_distribution')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classshark_1_1_data_distribution.html">shark::DataDistribution&lt; RealVector &gt;</a></td></tr>
<tr class="memitem:aa3f074650834a6551e8891eabedb396d inherit pub_methods_classshark_1_1_data_distribution" id="r_aa3f074650834a6551e8891eabedb396d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_data_distribution.html#aa3f074650834a6551e8891eabedb396d">~DataDistribution</a> ()</td></tr>
<tr class="memdesc:aa3f074650834a6551e8891eabedb396d inherit pub_methods_classshark_1_1_data_distribution"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor.  <br /></td></tr>
<tr class="separator:aa3f074650834a6551e8891eabedb396d inherit pub_methods_classshark_1_1_data_distribution"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81288ff28bf77b08bfa7ae6e7dbb1c5d inherit pub_methods_classshark_1_1_data_distribution" id="r_a81288ff28bf77b08bfa7ae6e7dbb1c5d"><td class="memItemLeft" align="right" valign="top">RealVector&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_data_distribution.html#a81288ff28bf77b08bfa7ae6e7dbb1c5d">operator()</a> ()</td></tr>
<tr class="separator:a81288ff28bf77b08bfa7ae6e7dbb1c5d inherit pub_methods_classshark_1_1_data_distribution"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a457baebeeff07baba0785aec80e7d188 inherit pub_methods_classshark_1_1_data_distribution" id="r_a457baebeeff07baba0785aec80e7d188"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classshark_1_1_unlabeled_data.html">UnlabeledData</a>&lt; RealVector &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_data_distribution.html#a457baebeeff07baba0785aec80e7d188">generateDataset</a> (std::size_t size, std::size_t maximumBatchSize) const</td></tr>
<tr class="memdesc:a457baebeeff07baba0785aec80e7d188 inherit pub_methods_classshark_1_1_data_distribution"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a data set with samples from from the distribution.  <br /></td></tr>
<tr class="separator:a457baebeeff07baba0785aec80e7d188 inherit pub_methods_classshark_1_1_data_distribution"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaaf36928f34de97b789be2dbd26947f9 inherit pub_methods_classshark_1_1_data_distribution" id="r_aaaf36928f34de97b789be2dbd26947f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classshark_1_1_unlabeled_data.html">UnlabeledData</a>&lt; RealVector &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classshark_1_1_data_distribution.html#aaaf36928f34de97b789be2dbd26947f9">generateDataset</a> (std::size_t size) const</td></tr>
<tr class="memdesc:aaaf36928f34de97b789be2dbd26947f9 inherit pub_methods_classshark_1_1_data_distribution"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generates a data set with samples from from the distribution.  <br /></td></tr>
<tr class="separator:aaaf36928f34de97b789be2dbd26947f9 inherit pub_methods_classshark_1_1_data_distribution"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Given a set of images, draws a set of image patches of a given size. </p>

<p class="definition">Definition at line <a class="el" href="_data_distribution_8h_source.html#l00403">403</a> of file <a class="el" href="_data_distribution_8h_source.html">DataDistribution.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aebd3397b0cd45f13561ffc1596e95973" name="aebd3397b0cd45f13561ffc1596e95973"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebd3397b0cd45f13561ffc1596e95973">&#9670;&#160;</a></span>ImagePatches()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">shark::ImagePatches::ImagePatches </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classshark_1_1_data.html">Data</a>&lt; RealVector &gt;&#160;</td>
          <td class="paramname"><em>images</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>imageWidth</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>imageHeight</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>patchWidth</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>patchHeight</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_data_distribution_8h_source.html#l00405">405</a> of file <a class="el" href="_data_distribution_8h_source.html">DataDistribution.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a01400c960d4da83f22837902c459d35e" name="a01400c960d4da83f22837902c459d35e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01400c960d4da83f22837902c459d35e">&#9670;&#160;</a></span>draw()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void shark::ImagePatches::draw </td>
          <td>(</td>
          <td class="paramtype">RealVector &amp;&#160;</td>
          <td class="paramname"><em>input</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Generates a single pair of input and label. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">input</td><td>the generated input </td></tr>
  </table>
  </dd>
</dl>

<p>Implements <a class="el" href="classshark_1_1_data_distribution.html#a3358c43ba05299220ff8df6d5ea7bc75">shark::DataDistribution&lt; RealVector &gt;</a>.</p>

<p class="definition">Definition at line <a class="el" href="_data_distribution_8h_source.html#l00416">416</a> of file <a class="el" href="_data_distribution_8h_source.html">DataDistribution.h</a>.</p>

<p class="reference">References <a class="el" href="namespaceshark_1_1random.html#aa64d4174eaf7111b03e0504eaa56b666">shark::random::discrete()</a>, <a class="el" href="group__shark__globals.html#ga0ea72a74a21d5ff59772516b83c4a58b">shark::Data&lt; Type &gt;::element()</a>, and <a class="el" href="namespaceshark_1_1random.html#ab5c1547eee483974d008d43f621a2234">shark::random::globalRng</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/shark/Data/<a class="el" href="_data_distribution_8h_source.html">DataDistribution.h</a></li>
</ul>
</div><!-- contents -->
</div>
</body>
</html>
